home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 3: The Continuation / 17-Bit_The_Continuation_Disc.iso / amigan / amigan 4 / blink / map.doc < prev   
Encoding:
Text File  |  1994-01-27  |  3.8 KB  |  101 lines

  1. BLINK Map file design
  2. by Edmund Burnette
  3. last update 01jun86
  4.  
  5. Command line options
  6. --------------------
  7.  
  8. MAP [[filename],option,option,...]
  9.    filename   map output file
  10.    option     letter of report to produce (see below)
  11.  
  12. WIDTH n        columns allowed in map file (default 80)
  13. INDENT n    columns to indent on a line (included in width) (default 0)
  14.         default 0
  15. HEIGHT n    lines on a page in map file (0 indicates no pagenation)
  16.         (default 55)
  17. HWIDTH n    width of hunk names (default 8)
  18. FWIDTH n    width of file names (default 16)
  19. PWIDTH n    width of program unit names (default 8)
  20. SWIDTH n    width of symbol names (default 8)
  21. FANCY        flag to allow printer control characters in the map file
  22.         (this is the default condition)
  23. PLAIN        turns off the FANCY option
  24.  
  25. Page format
  26. -----------
  27.  
  28. Each page will have up to three title lines, the last of which is optional.
  29. The first line will give the program name, section name, and page number.
  30. The second line is blank.  The third line is used for a column header if
  31. needed.
  32.  
  33. If the FANCY option is on, titles and headers will be underlined and
  34. the output will be separated into pages with form feed characters.
  35. The page number is given in two parts:  the section number and the page
  36. number within that section.
  37. * should the sections be numbered sequentially or should one number
  38. *   be assigned for a specific section for good?
  39.  
  40.    Example:
  41.  
  42.       myprog                  Hunks                               Page 1-1
  43.  
  44.       hunk name     type  diskoff     size
  45.  
  46.  
  47. Reports
  48. -------
  49.  
  50. The linker is capable of writing  many different kinds of reports to the
  51. map file.  Each report is listed below.  After the report name, a single
  52. letter appears in parenthesis.  This is the letter you would specify on
  53. the MAP option to produce that particular kind of report.
  54.  
  55. Note that all columnar data will be printed in multiple columns accross
  56. the page as space permits (you know what I mean).  This is not shown on
  57. most of the examples for clarity.
  58.  
  59.    1. Hunks (H) (default if no others specified)
  60.       hunk name     type  totsize filename         punit      offset
  61.       ---- -------- ---- -------- ---------------- -------- --------
  62.          1 xyz      code     3f8e sys:lib/c.o      c               0
  63.                                   ram:dump.o       dump          1e0
  64.                                   sys:lib/lc.lib   abort         4e8
  65.                                   ...
  66.          2 pdq      bss       123 ...
  67.          3 plugh    data       33 ...
  68.            
  69.    2. Symbols (S)
  70.       name       offset:hunk  name       offset:hunk ...
  71.       -------- -------------  -------- -------------
  72.       fred          27e:1     george          0:2
  73.       nchars          9:*     xyzzy        3f70:1
  74.  
  75.    3. Symbol xref (X)
  76.       name             value   offset:hunk   offset:hunk   offset:hunk ...
  77.       -------- ------------- ------------- ------------- -------------
  78.       fred           3e:1         140:1         5e6:1        1e78:1
  79.                                  2450:1           3:12      e8f77:12
  80.       ralph        1000:*          37:8 
  81.  
  82.    4. Files (F)
  83.       * ignore path in punit ?
  84.       * print blank name if not present (e.g., '<none>') ?
  85.       * don't print zero length protohunks?
  86.  
  87.       file             punit    name     type   offset:hunk     size
  88.       ---------------- -------- -------- ---- ------------- --------
  89.       sys:lib/c.o      c        text     code        0:1         1dc
  90.                                          data        0:3          60
  91.       ram:dump.o       dump     code     code      1e0:1         308
  92.                                 data     data       64:3          5c
  93.                                 bss      bss         0:0          54
  94.       sys:lib/lc.lib   abort             code      4e8:1          d0
  95.                                          data       c0:3          94
  96.                        iomode            data      114:3           4
  97.  
  98.  
  99.    5. Overlays (O)
  100.       ?
  101.